Cisco-IOS-XR-ipv4-vrrp-cfg API API Reference

API Endpoint
http://{Controller-IP}:{Controller-Port}/restconf/config/network-topology:network-topology/topology/topology-netconf/node/inetri/yang-ext:mount/
URL '/' code: %2F
Schemes: http
Version: 1.0.0
Leaf Color Code:
   Key  Mandatory  Optional

Paths

VRRP - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Update operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{        {
          
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] },
"state-change-disable": "null" VRRP state change IOS messages disable
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Create operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{        {
          
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] },
"state-change-disable": "null" VRRP state change IOS messages disable
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Delete operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/

Retrieve operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] },
"state-change-disable": "null" VRRP state change IOS messages disable
} } }

LOGGING - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Update operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{    
"state-change-disable": "null" VRRP state change IOS messages disable
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Create operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{    
"state-change-disable": "null" VRRP state change IOS messages disable
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/logging/

Retrieve operation of resource: logging

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"state-change-disable": "null" VRRP state change IOS messages disable
} }

INTERFACES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Update operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{      {
        
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Create operation of resource: interfaces

interfacesbody object

Request Content-Types: application/json
Request Example
{      {
        
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Delete operation of resource: interfaces

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/

Retrieve operation of resource: interfaces

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] } }

INTERFACE - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Update operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Create operation of resource: interface

interfacebody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Delete operation of resource: interface

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INTERFACE - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/

Retrieve operation of resource: interface

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"mac-refresh": "integer", VRRP Slave MAC-refresh rate in seconds
range: "0..10000"
units: "second"
default: "60"
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
},
"interface-name": "string", Object to be tracked, interface name for\ninterfaces
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
}, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP Secondary IPv4 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }, {
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } } ] }

IPV6 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Update operation of resource: ipv6

ipv6body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP virtual global IPv6 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP virtual global IPv6 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Create operation of resource: ipv6

ipv6body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP virtual global IPv6 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP virtual global IPv6 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Delete operation of resource: ipv6

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/

Retrieve operation of resource: ipv6

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP virtual global IPv6 address
} ] } } ] }, {
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP virtual global IPv6 address
},
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
}, {
"ip-address": "string" VRRP virtual global IPv6 address
} ] },
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"session-name": "string", VRRP Session Name
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }

VERSION3 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Update operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Create operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Delete operation of resource: version3

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/

Retrieve operation of resource: version3

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }

GLOBAL-IPV6-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Update operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Create operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Delete operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/

Retrieve operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }

GLOBAL-IPV6-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Update operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Create operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Delete operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Retrieve operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }

LINK-LOCAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/version3/virtual-routers/virtual-router/{vr-id}/link-local-ipv6-address/

Create operation of resource: link-local-ipv6-address

link-local-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP IPv6 virtual linklocal address
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Update operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Create operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Delete operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/

Retrieve operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }

SLAVE-VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Update operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Create operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Delete operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Retrieve operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }

LINK-LOCAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/link-local-ipv6-address/

Create operation of resource: link-local-ipv6-address

link-local-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    
"auto-configure": "boolean", TRUE if the virtual linklocal address is\nto be autoconfigured FALSE if an IPv6\nvirtual linklocal address is configured
"ip-address": "string" VRRP IPv6 virtual linklocal address
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Update operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Create operation of resource: global-ipv6-addresses

global-ipv6-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Delete operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/

Retrieve operation of resource: global-ipv6-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" VRRP virtual global IPv6 address
} ] } }

GLOBAL-IPV6-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Update operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Create operation of resource: global-ipv6-address

global-ipv6-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Delete operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GLOBAL-IPV6-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv6/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/global-ipv6-addresses/global-ipv6-address/{ip-address}/

Retrieve operation of resource: global-ipv6-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" VRRP virtual global IPv6 address
} ] }

DELAY - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Update operation of resource: delay

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Create operation of resource: delay

delaybody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Delete operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DELAY - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/delay/

Retrieve operation of resource: delay

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"reload-delay": "integer", Reload delay in seconds
range: "0..10000"
units: "second"
"min-delay": "integer" Minimum delay in seconds
range: "0..10000"
units: "second"
} }

IPV4 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Update operation of resource: ipv4

ipv4body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Create operation of resource: ipv4

ipv4body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Delete operation of resource: ipv4

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/

Retrieve operation of resource: ipv4

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }, { {
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }, {
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } } }

VERSION3 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Update operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Create operation of resource: version3

version3body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Delete operation of resource: version3

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION3 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/

Retrieve operation of resource: version3

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"priority": "integer", Priority value
range: "1..254"
default: "100"
{
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }, {
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"preempt": "integer" Preempt Master router if higher priority
range: "0..3600"
default: "0"
} ] } } }

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version3/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }

SLAVE-VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Update operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Create operation of resource: slave-virtual-routers

slave-virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Delete operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/

Retrieve operation of resource: slave-virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] } }

SLAVE-VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Update operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Create operation of resource: slave-virtual-router

slave-virtual-routerbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Delete operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SLAVE-VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/

Retrieve operation of resource: slave-virtual-router

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"follow": "string", VRRP Session name for this slave to follow
"slave-virtual-router-id": "integer", Virtual Router ID
range: "1..255"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"primary-ipv4-address": "string" The Primary VRRP IPv4 address
} ] }

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/slave-virtual-routers/slave-virtual-router/{slave-virtual-router-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

slave-virtual-router-id: string
in path

ID of slave-virtual-router-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }

VERSION2 - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Update operation of resource: version2

version2body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {              {
                
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Create operation of resource: version2

version2body object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{        {              {
                
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Delete operation of resource: version2

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VERSION2 - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/

Retrieve operation of resource: version2

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {              {
                
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } } }

VIRTUAL-ROUTERS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Update operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Create operation of resource: virtual-routers

virtual-routersbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Delete operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTERS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/

Retrieve operation of resource: virtual-routers

interface-name: string
in path

ID of interface-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] } }

VIRTUAL-ROUTER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Update operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Create operation of resource: virtual-router

virtual-routerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Delete operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIRTUAL-ROUTER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/

Retrieve operation of resource: virtual-router

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] },
"session-name": "string", VRRP Session Name
"bfd": "string", Enable use of Bidirectional Forwarding\nDetection for this IP
{
"priority": "integer", Priority value
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] },
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
},
"primary-ipv4-address": "string", The Primary VRRP IPv4 address
"priority": "integer", Priority value
range: "1..254"
default: "100"
"preempt": "integer", Preempt Master router if higher priority
range: "0..3600"
default: "0"
{
"ip-address": "string" VRRP Secondary IPv4 address
} ] },
"accept-mode-disable": "null", Disable Accept Mode for this virtual\nIPAddress
"vr-id": "integer", VRID Virtual Router Identifier
range: "1..255"
"text-password": "string" Authentication password, 8 chars max
} ] }

TIMER - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Update operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Create operation of resource: timer

timerbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Delete operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMER - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/timer/

Retrieve operation of resource: timer

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"advertisement-time-in-msec": "integer", Advertisement time in milliseconds
range: "100..40950"
units: "millisecond"
"forced": "boolean", TRUE - Force configured timer values to\nbe used, required when configured in\nmilliseconds
"advertisement-time-in-sec": "integer", Advertisement time in seconds
range: "1..255"
units: "second"
"in-msec": "boolean" TRUE - Advertise time configured in\nmilliseconds, FALSE - Advertise time\nconfigured in seconds
} }

SECONDARY-IPV4-ADDRESSES - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Update operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Create operation of resource: secondary-ipv4-addresses

secondary-ipv4-addressesbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Delete operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESSES - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/

Retrieve operation of resource: secondary-ipv4-addresses

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" VRRP Secondary IPv4 address
} ] } }

SECONDARY-IPV4-ADDRESS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Update operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Create operation of resource: secondary-ipv4-address

secondary-ipv4-addressbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Delete operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SECONDARY-IPV4-ADDRESS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/secondary-ipv4-addresses/secondary-ipv4-address/{ip-address}/

Retrieve operation of resource: secondary-ipv4-address

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" VRRP Secondary IPv4 address
} ] }

TRACKS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Update operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Create operation of resource: tracks

tracksbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Delete operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/

Retrieve operation of resource: tracks

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] } }

TRACK - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Update operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Create operation of resource: track

trackbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Delete operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACK - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracks/track/{interface-name}/

Retrieve operation of resource: track

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"priority": "integer", Priority decrement
range: "1..254"
default: "100"
"interface-name": "string" Object to be tracked, interface name for\ninterfaces
} ] }

TRACKED-OBJECTS - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Update operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Create operation of resource: tracked-objects

tracked-objectsbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Request Content-Types: application/json
Request Example
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Delete operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECTS - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/

Retrieve operation of resource: tracked-objects

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] } }

TRACKED-OBJECT - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Update operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Create operation of resource: tracked-object

tracked-objectbody object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Request Content-Types: application/json
Request Example
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Delete operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRACKED-OBJECT - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/ipv4/version2/virtual-routers/virtual-router/{vr-id}/tracked-objects/tracked-object/{object-name}/

Retrieve operation of resource: tracked-object

interface-name: string
in path

ID of interface-name

vr-id: string
in path

ID of vr-id

object-name: string
in path

ID of object-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"object-name": "string", Object to be tracked, interface name for\ninterfaces
"priority-decrement": "integer" Priority decrement
range: "1..254"
} ] }

BFD - Update

PUT Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Update operation of resource: bfd

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Create

POST Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Create operation of resource: bfd

bfdbody object

interface-name: string
in path

ID of interface-name

Request Content-Types: application/json
Request Example
{    
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Delete

DELETE Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Delete operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BFD - Retrieve

GET Cisco-IOS-XR-ipv4-vrrp-cfg:vrrp/interfaces/interface/{interface-name}/bfd/

Retrieve operation of resource: bfd

interface-name: string
in path

ID of interface-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"interval": "integer", Hello interval for BFD sessions created by\nvrrp
units: "millisecond"
"detection-multiplier": "integer" Detection multiplier for BFD sessions created\nby vrrp
range: "2..50"
} }

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/

Update operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/

Create operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/

Retrieve operation of resource: snmp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }

ENCRYPTED-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Update operation of resource: encrypted-community-maps

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Create operation of resource: encrypted-community-maps

encrypted-community-mapsbody object

Request Content-Types: application/json
Request Example
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Delete operation of resource: encrypted-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/

Retrieve operation of resource: encrypted-community-maps

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }

ENCRYPTED-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Update operation of resource: encrypted-community-map

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Create operation of resource: encrypted-community-map

encrypted-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Delete operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/encrypted-community-maps/encrypted-community-map/{community-name}/

Retrieve operation of resource: encrypted-community-map

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }

VIEWS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Update operation of resource: views

viewsbody object

Request Content-Types: application/json
Request Example
{      {
        
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Create operation of resource: views

viewsbody object

Request Content-Types: application/json
Request Example
{      {
        
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Delete operation of resource: views

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEWS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/

Retrieve operation of resource: views

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] } }

VIEW - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Update operation of resource: view

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{    {
      
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Create operation of resource: view

viewbody object

view-name family: string
in path

ID of view-name family

Request Content-Types: application/json
Request Example
{    {
      
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Delete operation of resource: view

view-name family: string
in path

ID of view-name family

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VIEW - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/views/view/{view-name family}/

Retrieve operation of resource: view

view-name family: string
in path

ID of view-name family

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"view-name": "string", Name of the view
"view-inclusion": "string", MIB view to be included or excluded
"family": "string" MIB view family name
} ] }

LOGGING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Update operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Create operation of resource: logging

loggingbody object

Request Content-Types: application/json
Request Example
{      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Delete operation of resource: logging

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

LOGGING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/

Retrieve operation of resource: logging

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} } }

THRESHOLD - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Update operation of resource: threshold

thresholdbody object

Request Content-Types: application/json
Request Example
{    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Create operation of resource: threshold

thresholdbody object

Request Content-Types: application/json
Request Example
{    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Delete operation of resource: threshold

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

THRESHOLD - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/logging/threshold/

Retrieve operation of resource: threshold

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"oid-processing": "integer", SNMP logging threshold for OID processing
range: "0..20000"
default: "500"
"pdu-processing": "integer" SNMP logging threshold for PDU processing
range: "0..20000"
default: "20000"
} }

ADMINISTRATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Update operation of resource: administration

administrationbody object

Request Content-Types: application/json
Request Example
{        {
          
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] }, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Create operation of resource: administration

administrationbody object

Request Content-Types: application/json
Request Example
{        {
          
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] }, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Delete operation of resource: administration

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ADMINISTRATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/

Retrieve operation of resource: administration

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] }, {
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } } }

DEFAULT-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Update operation of resource: default-communities

default-communitiesbody object

Request Content-Types: application/json
Request Example
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Create operation of resource: default-communities

default-communitiesbody object

Request Content-Types: application/json
Request Example
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Delete operation of resource: default-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/

Retrieve operation of resource: default-communities

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }

DEFAULT-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Update operation of resource: default-community

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Create operation of resource: default-community

default-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Delete operation of resource: default-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/default-communities/default-community/{community-name}/

Retrieve operation of resource: default-community

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }

ENCRYPTED-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Update operation of resource: encrypted-communities

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Create operation of resource: encrypted-communities

encrypted-communitiesbody object

Request Content-Types: application/json
Request Example
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Delete operation of resource: encrypted-communities

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/

Retrieve operation of resource: encrypted-communities

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} ] } }

ENCRYPTED-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Update operation of resource: encrypted-community

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Create operation of resource: encrypted-community

encrypted-communitybody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Delete operation of resource: encrypted-community

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/administration/encrypted-communities/encrypted-community/{community-name}/

Retrieve operation of resource: encrypted-community

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"priviledge": "string", Read/Write Access
"view-name": "string", MIB view to which the community has access
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"community-name": "string", SNMP community string
"owner": "string", Logical Router or System owner access
"v4acl-type": "string", Access-list type
"v4-access-list": "string" Ipv4 Access-list name
} }

AGENT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Update operation of resource: agent

agentbody object

Request Content-Types: application/json
Request Example
{          {
            
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Create operation of resource: agent

agentbody object

Request Content-Types: application/json
Request Example
{          {
            
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Delete operation of resource: agent

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

AGENT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/

Retrieve operation of resource: agent

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{          {
            
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} } }

ENGINE-ID - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Update operation of resource: engine-id

engine-idbody object

Request Content-Types: application/json
Request Example
{        {
          
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Create operation of resource: engine-id

engine-idbody object

Request Content-Types: application/json
Request Example
{        {
          
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Delete operation of resource: engine-id

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENGINE-ID - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/

Retrieve operation of resource: engine-id

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] },
"local": "string" engineID of the local agent
} }

REMOTES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Update operation of resource: remotes

remotesbody object

Request Content-Types: application/json
Request Example
{      {
        
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Create operation of resource: remotes

remotesbody object

Request Content-Types: application/json
Request Example
{      {
        
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Delete operation of resource: remotes

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/

Retrieve operation of resource: remotes

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] } }

REMOTE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Update operation of resource: remote

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{    {
      
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Create operation of resource: remote

remotebody object

remote-address: string
in path

ID of remote-address

Request Content-Types: application/json
Request Example
{    {
      
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Delete operation of resource: remote

remote-address: string
in path

ID of remote-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

REMOTE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/agent/engine-id/remotes/remote/{remote-address}/

Retrieve operation of resource: remote

remote-address: string
in path

ID of remote-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"remote-engine-id": "string", engine ID octet string
"remote-address": "string", IP address of remote SNMP entity
"port": "string" UDP port number
} ] }

TRAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Update operation of resource: trap

trapbody object

Request Content-Types: application/json
Request Example
{    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Create operation of resource: trap

trapbody object

Request Content-Types: application/json
Request Example
{    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Delete operation of resource: trap

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap/

Retrieve operation of resource: trap

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"queue-length": "integer", Message queue length for each TRAP host
range: "1..5000"
"throttle-time": "integer", Set throttle time for handling traps
range: "50..1000"
units: "millisecond"
"timeout": "integer" Timeout for TRAP message retransmissions
range: "1..600000"
units: "millisecond"
} }

DROP-PACKET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Update operation of resource: drop-packet

drop-packetbody object

Request Content-Types: application/json
Request Example
{    
"unknown-user": "null" Enable drop unknown user name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Create operation of resource: drop-packet

drop-packetbody object

Request Content-Types: application/json
Request Example
{    
"unknown-user": "null" Enable drop unknown user name
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Delete operation of resource: drop-packet

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DROP-PACKET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/drop-packet/

Retrieve operation of resource: drop-packet

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"unknown-user": "null" Enable drop unknown user name
} }

IPV6 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Update operation of resource: ipv6

ipv6body object

Request Content-Types: application/json
Request Example
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Create operation of resource: ipv6

ipv6body object

Request Content-Types: application/json
Request Example
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Delete operation of resource: ipv6

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV6 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/

Retrieve operation of resource: ipv6

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Update operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Create operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv6/tos/

Retrieve operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }

IPV4 - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Update operation of resource: ipv4

ipv4body object

Request Content-Types: application/json
Request Example
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Create operation of resource: ipv4

ipv4body object

Request Content-Types: application/json
Request Example
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Delete operation of resource: ipv4

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

IPV4 - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/

Retrieve operation of resource: ipv4

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} } }

TOS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Update operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Create operation of resource: tos

tosbody object

Request Content-Types: application/json
Request Example
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Delete operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TOS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/ipv4/tos/

Retrieve operation of resource: tos

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"type": "string", SNMP TOS type DSCP or Precedence
"dscp": "string", SNMP DSCP value
"precedence": "string" SNMP Precedence value
} }

SYSTEM - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Update operation of resource: system

systembody object

Request Content-Types: application/json
Request Example
{    
"chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Create operation of resource: system

systembody object

Request Content-Types: application/json
Request Example
{    
"chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Delete operation of resource: system

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SYSTEM - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/system/

Retrieve operation of resource: system

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"chassis-id": "string", String to uniquely identify this chassis
"contact": "string", identification of the contact person for this\nmanaged node
"location": "string" The physical location of this node
} }

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Update operation of resource: target

targetbody object

Request Content-Types: application/json
Request Example
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Create operation of resource: target

targetbody object

Request Content-Types: application/json
Request Example
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Delete operation of resource: target

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/

Retrieve operation of resource: target

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }

TARGETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Update operation of resource: targets

targetsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Create operation of resource: targets

targetsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Delete operation of resource: targets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/

Retrieve operation of resource: targets

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } ] } }

TARGET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Update operation of resource: target

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Create operation of resource: target

targetbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Delete operation of resource: target

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/

Retrieve operation of resource: target

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"ip-address": "string" IPv4/Ipv6 address
} ] },
"target-list-name": "string", Name of the target list
{
"name": "string" VRF Name
} ] } } }

VRF-NAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Update operation of resource: vrf-names

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        
"name": "string" VRF Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Create operation of resource: vrf-names

vrf-namesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        
"name": "string" VRF Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Delete operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/

Retrieve operation of resource: vrf-names

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"name": "string" VRF Name
} ] } }

VRF-NAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Update operation of resource: vrf-name

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      
"name": "string" VRF Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Create operation of resource: vrf-name

vrf-namebody object

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      
"name": "string" VRF Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Delete operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF-NAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/vrf-names/vrf-name/{name}/

Retrieve operation of resource: vrf-name

target-list-name: string
in path

ID of target-list-name

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"name": "string" VRF Name
} ] }

TARGET-ADDRESSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Update operation of resource: target-addresses

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" IPv4/Ipv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Create operation of resource: target-addresses

target-addressesbody object

target-list-name: string
in path

ID of target-list-name

Request Content-Types: application/json
Request Example
{      {
        
"ip-address": "string" IPv4/Ipv6 address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Delete operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/

Retrieve operation of resource: target-addresses

target-list-name: string
in path

ID of target-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"ip-address": "string" IPv4/Ipv6 address
} ] } }

TARGET-ADDRESS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Update operation of resource: target-address

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" IPv4/Ipv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Create operation of resource: target-address

target-addressbody object

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {
      
"ip-address": "string" IPv4/Ipv6 address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Delete operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TARGET-ADDRESS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/target/targets/target/{target-list-name}/target-addresses/target-address/{ip-address}/

Retrieve operation of resource: target-address

target-list-name: string
in path

ID of target-list-name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"ip-address": "string" IPv4/Ipv6 address
} ] }

NOTIFICATION - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Update operation of resource: notification

notificationbody object

Request Content-Types: application/json
Request Example
{      
"enable": "null" Enable SNMP notifications
},
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Create operation of resource: notification

notificationbody object

Request Content-Types: application/json
Request Example
{      
"enable": "null" Enable SNMP notifications
},
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Delete operation of resource: notification

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NOTIFICATION - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/

Retrieve operation of resource: notification

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      
"enable": "null" Enable SNMP notifications
},
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} } }

SNMP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Update operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Create operation of resource: snmp

snmpbody object

Request Content-Types: application/json
Request Example
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Delete operation of resource: snmp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SNMP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/snmp/

Retrieve operation of resource: snmp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"authentication": "null", Enable authentication notification
"enable": "null", Enable SNMP notifications
"warm-start": "null", Enable warm start notification
"cold-start": "null" Enable cold start notification
} }

VRRP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Update operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{    
"enable": "null" Enable VRRP-MIB notifications
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Create operation of resource: vrrp

vrrpbody object

Request Content-Types: application/json
Request Example
{    
"enable": "null" Enable VRRP-MIB notifications
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Delete operation of resource: vrrp

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRRP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/notification/vrrp/

Retrieve operation of resource: vrrp

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"enable": "null" Enable VRRP-MIB notifications
} }

CORRELATOR - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Update operation of resource: correlator

correlatorbody object

Request Content-Types: application/json
Request Example
{        {              {                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
} ] }, {
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] },
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Create operation of resource: correlator

correlatorbody object

Request Content-Types: application/json
Request Example
{        {              {                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
} ] }, {
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] },
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Delete operation of resource: correlator

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CORRELATOR - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/

Retrieve operation of resource: correlator

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {              {                    {
                      
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Ruleset name
} ] }, {
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] },
"buffer-size": "integer" Configure size of the correlator buffer
range: "1024..2147483647"
units: "byte"
} }

RULES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Update operation of resource: rules

rulesbody object

Request Content-Types: application/json
Request Example
{      {            {                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Create operation of resource: rules

rulesbody object

Request Content-Types: application/json
Request Example
{      {            {                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Delete operation of resource: rules

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/

Retrieve operation of resource: rules

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {                  {
                    
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] } }

RULE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Update operation of resource: rule

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Create operation of resource: rule

rulebody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Delete operation of resource: rule

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/

Retrieve operation of resource: rule

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {                {
                  
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }, { {
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] },
"timeout": "integer", Timeout (time to wait for active correlation)\nin milliseconds
range: "1..600000"
units: "millisecond"
"name": "string" Rule name
} ] }

ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Update operation of resource: root-causes

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Create operation of resource: root-causes

root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Delete operation of resource: root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/

Retrieve operation of resource: root-causes

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] } }

ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Update operation of resource: root-cause

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Create operation of resource: root-cause

root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Delete operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/

Retrieve operation of resource: root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"oid": "string", OID of rootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of rootcause trap (dotted decimal)
"created": "null" Create rootcause
} ] }

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Update operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Create operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/root-causes/root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }

NON-ROOT-CAUSES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Update operation of resource: non-root-causes

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Create operation of resource: non-root-causes

non-root-causesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Delete operation of resource: non-root-causes

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/

Retrieve operation of resource: non-root-causes

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] } }

NON-ROOT-CAUSE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Update operation of resource: non-root-cause

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Create operation of resource: non-root-cause

non-root-causebody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Delete operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

NON-ROOT-CAUSE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/

Retrieve operation of resource: non-root-cause

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"oid": "string", OID of nonrootcause trap (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] },
"oid": "string", OID of nonrootcause trap (dotted decimal)
"created": "null" Create nonrootcause
} ] }

VAR-BINDS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Update operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Create operation of resource: var-binds

var-bindsbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Delete operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BINDS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/

Retrieve operation of resource: var-binds

name: string
in path

ID of name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] } }

VAR-BIND - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Update operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Create operation of resource: var-bind

var-bindbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Delete operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VAR-BIND - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/

Retrieve operation of resource: var-bind

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"oid": "string", OID of varbind (dotted decimal)
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} } ] }

MATCH - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Update operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Create operation of resource: match

matchbody object

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Delete operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MATCH - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/non-root-causes/non-root-cause/{oid}/var-binds/var-bind/{oid}/match/

Retrieve operation of resource: match

name: string
in path

ID of name

oid: string
in path

ID of oid

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"index": "string", Regular Expression to match index
"value": "string" Regular Expression to match value
} }

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Update operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Create operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Update operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Create operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rules/rule/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }

RULE-SETS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Update operation of resource: rule-sets

rule-setsbody object

Request Content-Types: application/json
Request Example
{      {          
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Create operation of resource: rule-sets

rule-setsbody object

Request Content-Types: application/json
Request Example
{      {          
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Delete operation of resource: rule-sets

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SETS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/

Retrieve operation of resource: rule-sets

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {          
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] } }

RULE-SET - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Update operation of resource: rule-set

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {        
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Create operation of resource: rule-set

rule-setbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {        
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Delete operation of resource: rule-set

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULE-SET - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/

Retrieve operation of resource: rule-set

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {        
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } },
"name": "string", Ruleset name
{
"rulename": "string" Rule name
} ] } } ] }

RULENAMES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Update operation of resource: rulenames

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"rulename": "string" Rule name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Create operation of resource: rulenames

rulenamesbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"rulename": "string" Rule name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Delete operation of resource: rulenames

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAMES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/

Retrieve operation of resource: rulenames

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"rulename": "string" Rule name
} ] } }

RULENAME - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Update operation of resource: rulename

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{    {
      
"rulename": "string" Rule name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Create operation of resource: rulename

rulenamebody object

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Request Content-Types: application/json
Request Example
{    {
      
"rulename": "string" Rule name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Delete operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

RULENAME - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/rulenames/rulename/{rulename}/

Retrieve operation of resource: rulename

name: string
in path

ID of name

rulename: string
in path

ID of rulename

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"rulename": "string" Rule name
} ] }

APPLIED-TO - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Update operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Create operation of resource: applied-to

applied-tobody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Delete operation of resource: applied-to

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

APPLIED-TO - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/

Retrieve operation of resource: applied-to

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"all": "null", Apply to all of the device
{
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } } }

HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Update operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Create operation of resource: hosts

hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Delete operation of resource: hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/

Retrieve operation of resource: hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] } }

HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Update operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Create operation of resource: host

hostbody object

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Request Content-Types: application/json
Request Example
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Delete operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/correlator/rule-sets/rule-set/{name}/applied-to/hosts/host/{ip-address port}/

Retrieve operation of resource: host

name: string
in path

ID of name

ip-address port: string
in path

ID of ip-address port

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"port": "string", Port (specify 162 for default)
"ip-address": "string" IP address
} ] }

BULK-STATS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Update operation of resource: bulk-stats

bulk-statsbody object

Request Content-Types: application/json
Request Example
{    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
{
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" The name of the schema
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }, {
"object-list-name": "string", Name of the object List
{
"oid": "string" Object name or OID
} ] },
"type": "null" Configure schema name
} ] }, {
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Create operation of resource: bulk-stats

bulk-statsbody object

Request Content-Types: application/json
Request Example
{    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
{
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" The name of the schema
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }, {
"object-list-name": "string", Name of the object List
{
"oid": "string" Object name or OID
} ] },
"type": "null" Configure schema name
} ] }, {
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Delete operation of resource: bulk-stats

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

BULK-STATS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/

Retrieve operation of resource: bulk-stats

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"memory": "integer", per process memory limit in kilo bytes
range: "100..200000"
units: "kilobyte"
{
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" The name of the schema
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure schema name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }, {
"object-list-name": "string", Name of the object List
{
"oid": "string" Object name or OID
} ] },
"type": "null" Configure schema name
} ] }, {
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } } }

SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Update operation of resource: schemas

schemasbody object

Request Content-Types: application/json
Request Example
{      {
        
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Create operation of resource: schemas

schemasbody object

Request Content-Types: application/json
Request Example
{      {
        
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Delete operation of resource: schemas

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/

Retrieve operation of resource: schemas

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] } }

SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Update operation of resource: schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    {
      
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Create operation of resource: schema

schemabody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    {
      
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Delete operation of resource: schema

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/

Retrieve operation of resource: schema

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"schema-name": "string", The name of the schema
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Configure schema name
},
"type": "null", Configure schema name
"schema-object-list": "string", Name of an object List
"poll-interval": "integer" Periodicity for polling of objects in this\nschema in minutes
range: "1..20000"
units: "minute"
} ] }

INSTANCE - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Update operation of resource: instance

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Create operation of resource: instance

instancebody object

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Delete operation of resource: instance

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INSTANCE - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/schemas/schema/{schema-name}/instance/

Retrieve operation of resource: instance

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"end": "string", End Instance OID for repetition
"sub-interface": "boolean", Include all the subinterface
"start": "string", Start Instance OID for repetition
"max": "integer", Max value of Instance repetition
"instance": "string", Instance of the schema
"type": "string" Type of the instance
} }

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Update operation of resource: objects

objectsbody object

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string" Object name or OID
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Create operation of resource: objects

objectsbody object

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string" Object name or OID
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Delete operation of resource: objects

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/

Retrieve operation of resource: objects

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"oid": "string" Object name or OID
} ] } }

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Update operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string" Object name or OID
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Create operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string" Object name or OID
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"oid": "string" Object name or OID
} ] }

OBJECTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Update operation of resource: objects

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string" Object name or OID
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Create operation of resource: objects

objectsbody object

object-list-name: string
in path

ID of object-list-name

Request Content-Types: application/json
Request Example
{      {
        
"oid": "string" Object name or OID
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Delete operation of resource: objects

object-list-name: string
in path

ID of object-list-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/

Retrieve operation of resource: objects

object-list-name: string
in path

ID of object-list-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"oid": "string" Object name or OID
} ] } }

OBJECT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Update operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string" Object name or OID
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Create operation of resource: object

objectbody object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Request Content-Types: application/json
Request Example
{    {
      
"oid": "string" Object name or OID
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Delete operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OBJECT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/objects/object/{object-list-name}/objects/object/{oid}/

Retrieve operation of resource: object

object-list-name: string
in path

ID of object-list-name

oid: string
in path

ID of oid

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"oid": "string" Object name or OID
} ] }

TRANSFERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Update operation of resource: transfers

transfersbody object

Request Content-Types: application/json
Request Example
{      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Create operation of resource: transfers

transfersbody object

Request Content-Types: application/json
Request Example
{      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Delete operation of resource: transfers

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/

Retrieve operation of resource: transfers

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] } }

TRANSFER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Update operation of resource: transfer

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Create operation of resource: transfer

transferbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Delete operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/

Retrieve operation of resource: transfer

transfer-name: string
in path

ID of transfer-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"retry": "integer", Number of transmission retries
range: "0..100"
{
"schema-name": "string" Schema that contains objects to be\ncollected
} ] },
"format": "string", Format of the bulk data file
"interval": "integer", Periodicity for the transfer of bulk data in\nminutes
units: "millisecond"
"primary": "string", FTP or rcp or TFTP can be used for file\ntransfer
"buffer-size": "integer", Bulkstat data file maximum size in bytes
range: "1024..2147483647"
units: "byte"
"enable": "null", Start Data Collection for this Configuration
"transfer-name": "string", Name of bulk transfer
"retain": "integer", Retention period in minutes
range: "0..20000"
units: "minute"
"type": "null", Configure transfer list name
"secondary": "string" FTP or rcp or TFTP can be used for file\ntransfer
} ] }

TRANSFER-SCHEMAS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Update operation of resource: transfer-schemas

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{      {
        
"schema-name": "string" Schema that contains objects to be\ncollected
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Create operation of resource: transfer-schemas

transfer-schemasbody object

transfer-name: string
in path

ID of transfer-name

Request Content-Types: application/json
Request Example
{      {
        
"schema-name": "string" Schema that contains objects to be\ncollected
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Delete operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMAS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/

Retrieve operation of resource: transfer-schemas

transfer-name: string
in path

ID of transfer-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"schema-name": "string" Schema that contains objects to be\ncollected
} ] } }

TRANSFER-SCHEMA - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Update operation of resource: transfer-schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    {
      
"schema-name": "string" Schema that contains objects to be\ncollected
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Create operation of resource: transfer-schema

transfer-schemabody object

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Request Content-Types: application/json
Request Example
{    {
      
"schema-name": "string" Schema that contains objects to be\ncollected
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Delete operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRANSFER-SCHEMA - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/bulk-stats/transfers/transfer/{transfer-name}/transfer-schemas/transfer-schema/{schema-name}/

Retrieve operation of resource: transfer-schema

transfer-name: string
in path

ID of transfer-name

schema-name: string
in path

ID of schema-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"schema-name": "string" Schema that contains objects to be\ncollected
} ] }

DEFAULT-COMMUNITY-MAPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Update operation of resource: default-community-maps

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Create operation of resource: default-community-maps

default-community-mapsbody object

Request Content-Types: application/json
Request Example
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Delete operation of resource: default-community-maps

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/

Retrieve operation of resource: default-community-maps

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] } }

DEFAULT-COMMUNITY-MAP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Update operation of resource: default-community-map

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Create operation of resource: default-community-map

default-community-mapbody object

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Delete operation of resource: default-community-map

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-COMMUNITY-MAP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/default-community-maps/default-community-map/{community-name}/

Retrieve operation of resource: default-community-map

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"security": "string", SNMP Security Name
"community-name": "string", SNMP community map
"context": "string", SNMP Context Name
"target-list": "string" target list name
} ] }

OVERLOAD-CONTROL - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Update operation of resource: overload-control

overload-controlbody object

Request Content-Types: application/json
Request Example
{    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Create operation of resource: overload-control

overload-controlbody object

Request Content-Types: application/json
Request Example
{    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Delete operation of resource: overload-control

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

OVERLOAD-CONTROL - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/overload-control/

Retrieve operation of resource: overload-control

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"drop-time": "integer", Drop time in seconds for incoming queue\n(default 1 sec)
range: "0..300"
units: "second"
"throttle-rate": "integer" Throttle time in milliseconds for incoming\nqueue (default 500 msec)
range: "0..1000"
units: "millisecond"
} }

TIMEOUTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Update operation of resource: timeouts

timeoutsbody object

Request Content-Types: application/json
Request Example
{    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Create operation of resource: timeouts

timeoutsbody object

Request Content-Types: application/json
Request Example
{    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Delete operation of resource: timeouts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TIMEOUTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/timeouts/

Retrieve operation of resource: timeouts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"duplicates": "integer", Duplicate request feature timeout
range: "0..20"
units: "second"
default: "1"
"pdu-stats": "integer", SNMP pdu statistics timeout
range: "1..10"
units: "second"
default: "2"
"in-qdrop": "integer", incoming queue drop feature timeout
range: "0..20"
units: "second"
default: "10"
"subagent": "integer" Sub-Agent Request timeout
range: "1..20"
units: "second"
default: "10"
} }

USERS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Update operation of resource: users

usersbody object

Request Content-Types: application/json
Request Example
{      {
        
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Create operation of resource: users

usersbody object

Request Content-Types: application/json
Request Example
{      {
        
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Delete operation of resource: users

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USERS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/

Retrieve operation of resource: users

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] } }

USER - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Update operation of resource: user

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{    {
      
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Create operation of resource: user

userbody object

user-name: string
in path

ID of user-name

Request Content-Types: application/json
Request Example
{    {
      
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Delete operation of resource: user

user-name: string
in path

ID of user-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

USER - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/users/user/{user-name}/

Retrieve operation of resource: user

user-name: string
in path

ID of user-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"v6acl-type": "string", Access-list type
"group-name": "string", Group to which the user belongs
"v6-access-list": "string", Ipv6 Access-list name
"priv-algorithm": "string", The algorithm used des56 or aes128 or aes192or\naes256 or 3des
"owner": "string", The system access either SDROwner or\nSystemOwner
"v4acl-type": "string", Access-list type
"privacy-password": "string", The privacy password
"remote-address": "string", IP address of remote SNMP entity
"port": "string", UDP port number
"user-name": "string", Name of the user
"algorithm": "string", The algorithm used md5 or sha
"privacy-password-configured": "null", Flag to indicate that the privacy password is\nconfigured for version 3
"authentication-password": "string", The authentication password
"version": "string", SNMP version to be used. v1,v2c or v3
"v4-access-list": "string", Ipv4 Access-list name
"authentication-password-configured": "null" Flag to indicate that authentication password\nis configred for version 3
} ] }

VRFS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Update operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Create operation of resource: vrfs

vrfsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Delete operation of resource: vrfs

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRFS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/

Retrieve operation of resource: vrfs

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] } }

VRF - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Update operation of resource: vrf

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {
            
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Create operation of resource: vrf

vrfbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {          {
            
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Delete operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

VRF - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/

Retrieve operation of resource: vrf

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"context-name": "string" Context Name
} ] }, { {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] },
"name": "string", VRF name
{
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } } ] }

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Update operation of resource: trap-hosts

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Create operation of resource: trap-hosts

trap-hostsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Delete operation of resource: trap-hosts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/

Retrieve operation of resource: trap-hosts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

trap-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

inform-hostbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

inform-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

inform-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

default-user-communitiesbody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

default-user-communitybody object

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

name: string
in path

ID of name

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Update operation of resource: contexts

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"context-name": "string" Context Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Create operation of resource: contexts

contextsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"context-name": "string" Context Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Delete operation of resource: contexts

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/

Retrieve operation of resource: contexts

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"context-name": "string" Context Name
} ] } }

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Update operation of resource: context

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{    {
      
"context-name": "string" Context Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Create operation of resource: context

contextbody object

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{    {
      
"context-name": "string" Context Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Delete operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/contexts/context/{context-name}/

Retrieve operation of resource: context

name: string
in path

ID of name

context-name: string
in path

ID of context-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"context-name": "string" Context Name
} ] }

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Update operation of resource: context-mappings

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Create operation of resource: context-mappings

context-mappingsbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Delete operation of resource: context-mappings

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/

Retrieve operation of resource: context-mappings

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

context-mappingbody object

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/vrfs/vrf/{name}/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

name: string
in path

ID of name

context-mapping-name: string
in path

ID of context-mapping-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }

GROUPS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Update operation of resource: groups

groupsbody object

Request Content-Types: application/json
Request Example
{      {
        
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Create operation of resource: groups

groupsbody object

Request Content-Types: application/json
Request Example
{      {
        
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Delete operation of resource: groups

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUPS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/

Retrieve operation of resource: groups

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] } }

GROUP - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Update operation of resource: group

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Create operation of resource: group

groupbody object

name: string
in path

ID of name

Request Content-Types: application/json
Request Example
{    {
      
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Delete operation of resource: group

name: string
in path

ID of name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

GROUP - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/groups/group/{name}/

Retrieve operation of resource: group

name: string
in path

ID of name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"name": "string", Name of the group
"write-view": "string", write view name
"snmp-version": "string", snmp version
"context-name": "string", Context name
"security-model": "string", security model like auth/noAuth/Priv\napplicable for v3
"v6acl-type": "string", Access-list type
"v6-access-list": "string", Ipv6 Access-list name
"read-view": "string", read view name
"v4acl-type": "string", Access-list type
"v4-access-list": "string", Ipv4 Access-list name
"notify-view": "string" notify view name
} ] }

TRAP-HOSTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Update operation of resource: trap-hosts

trap-hostsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Create operation of resource: trap-hosts

trap-hostsbody object

Request Content-Types: application/json
Request Example
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Delete operation of resource: trap-hosts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOSTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/

Retrieve operation of resource: trap-hosts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {            {
              
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] } }

TRAP-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Update operation of resource: trap-host

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Create operation of resource: trap-host

trap-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Delete operation of resource: trap-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

TRAP-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/

Retrieve operation of resource: trap-host

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {          {
            
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } },
"ip-address": "string", IP address of SNMP notification host
{
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } ] }

ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Update operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Create operation of resource: encrypted-user-communities

encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Delete operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/

Retrieve operation of resource: encrypted-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Update operation of resource: encrypted-user-community

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Create operation of resource: encrypted-user-community

encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Delete operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/encrypted-user-communities/encrypted-user-community/{community-name}/

Retrieve operation of resource: encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

INFORM-HOST - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Update operation of resource: inform-host

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Create operation of resource: inform-host

inform-hostbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Delete operation of resource: inform-host

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-HOST - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/

Retrieve operation of resource: inform-host

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{        {
          
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] }, {
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } } }

INFORM-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Update operation of resource: inform-user-communities

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Create operation of resource: inform-user-communities

inform-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Delete operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/

Retrieve operation of resource: inform-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

INFORM-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Update operation of resource: inform-user-community

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Create operation of resource: inform-user-community

inform-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Delete operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-user-communities/inform-user-community/{community-name}/

Retrieve operation of resource: inform-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

INFORM-ENCRYPTED-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Update operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Create operation of resource: inform-encrypted-user-communities

inform-encrypted-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Delete operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/

Retrieve operation of resource: inform-encrypted-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

INFORM-ENCRYPTED-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Update operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Create operation of resource: inform-encrypted-user-community

inform-encrypted-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Delete operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

INFORM-ENCRYPTED-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/inform-host/inform-encrypted-user-communities/inform-encrypted-user-community/{community-name}/

Retrieve operation of resource: inform-encrypted-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v2c/v3
"community-name": "string", SNMPv2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this\nvalue to an integer corresponding to the\ntrapBGP 8192, CONFIG 4096,SYSLOG 131072\n,SNMP_TRAP 1COPY_COMPLETE_TRAP 64To provide\na combination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set\nas 0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

DEFAULT-USER-COMMUNITIES - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Update operation of resource: default-user-communities

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Create operation of resource: default-user-communities

default-user-communitiesbody object

ip-address: string
in path

ID of ip-address

Request Content-Types: application/json
Request Example
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Delete operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITIES - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/

Retrieve operation of resource: default-user-communities

ip-address: string
in path

ID of ip-address

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} ] } }

DEFAULT-USER-COMMUNITY - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Update operation of resource: default-user-community

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Create operation of resource: default-user-community

default-user-communitybody object

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Request Content-Types: application/json
Request Example
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Delete operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

DEFAULT-USER-COMMUNITY - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/trap-hosts/trap-host/{ip-address}/default-user-communities/default-user-community/{community-name}/

Retrieve operation of resource: default-user-community

ip-address: string
in path

ID of ip-address

community-name: string
in path

ID of community-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    
"port": "string", UDP port number
"version": "string", SNMP Version to be used v1/v2c/v3
"community-name": "string", SNMPv1/v2c community string or SNMPv3 user
"basic-trap-types": "integer", Number to signify the feature traps that\nneeds to be setBasicTrapTypes is used for\nall traps except copy-completeSet this value\nto an integer corresponding to the trapBGP\n8192, CONFIG 4096,SYSLOG 131072,SNMP_TRAP\n1COPY_COMPLETE_TRAP 64To provide a\ncombination of trap Add the respective\nnumbersValue must be set to 0 for all traps
"advanced-trap-types2": "integer", Number to signify the feature traps that\nneeds to be setvalue should always to set as\n0
"security-level": "string", Security level to be used noauth/auth/priv
"advanced-trap-types1": "integer" Number to signify the feature traps that\nneeds to be setUse this for providing\ncopy-complete trapValue must be set to 0 if\nnot used
} }

CONTEXTS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Update operation of resource: contexts

contextsbody object

Request Content-Types: application/json
Request Example
{      {
        
"context-name": "string" Context Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Create operation of resource: contexts

contextsbody object

Request Content-Types: application/json
Request Example
{      {
        
"context-name": "string" Context Name
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Delete operation of resource: contexts

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXTS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/

Retrieve operation of resource: contexts

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"context-name": "string" Context Name
} ] } }

CONTEXT - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Update operation of resource: context

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{    {
      
"context-name": "string" Context Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Create operation of resource: context

contextbody object

context-name: string
in path

ID of context-name

Request Content-Types: application/json
Request Example
{    {
      
"context-name": "string" Context Name
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Delete operation of resource: context

context-name: string
in path

ID of context-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/contexts/context/{context-name}/

Retrieve operation of resource: context

context-name: string
in path

ID of context-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"context-name": "string" Context Name
} ] }

CONTEXT-MAPPINGS - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Update operation of resource: context-mappings

context-mappingsbody object

Request Content-Types: application/json
Request Example
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Create operation of resource: context-mappings

context-mappingsbody object

Request Content-Types: application/json
Request Example
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Delete operation of resource: context-mappings

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPINGS - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/

Retrieve operation of resource: context-mappings

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{      {
        
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] } }

CONTEXT-MAPPING - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Update operation of resource: context-mapping

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Create

POST Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Create operation of resource: context-mapping

context-mappingbody object

context-mapping-name: string
in path

ID of context-mapping-name

Request Content-Types: application/json
Request Example
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Delete operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

CONTEXT-MAPPING - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:snmp/context-mappings/context-mapping/{context-mapping-name}/

Retrieve operation of resource: context-mapping

context-mapping-name: string
in path

ID of context-mapping-name

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{    {
      
"context-mapping-name": "string", Context mapping name
"vrf-name": "string", VRF name associated with the context
"topology-name": "string", Topology name associated with the context
"context": "string", SNMP context feature type
"instance-name": "string" OSPF protocol instance
} ] }

MIB - Update

PUT Cisco-IOS-XR-snmp-agent-cfg:mib/

Update operation of resource: mib

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Create

POST Cisco-IOS-XR-snmp-agent-cfg:mib/

Create operation of resource: mib

mibbody object

Request Content-Types: application/json
Request Example
200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Delete

DELETE Cisco-IOS-XR-snmp-agent-cfg:mib/

Delete operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json

MIB - Retrieve

GET Cisco-IOS-XR-snmp-agent-cfg:mib/

Retrieve operation of resource: mib

200 OK

Successful operation

400 Bad Request

Internal Error

Response Content-Types: application/json
Response Example (200 OK)
{